<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Class bmqa::MessagePropertiesIterator</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="bdedox.css" rel="stylesheet" type="text/css"/>
    <style>
      div.hanging {
        padding-left: 0.75in;
        text-indent: -0.50in;
      }
      div.unhanging {
        text-indent:     0in;
      }
      a.glossary {
        font-weight: bold;
        font-style: italic;
      }
    </style>
</head>
<!--
<body onload='searchBox.OnSelectItem(0);'>
-->
<body>

<table border=2 cellspacing=0 cellpadding=0 align=center>
<tr>
 <td valign=top align=center>
 <p align=center><b><i>Quick Links:</i></b></p>
 </td>
 <td valign=top align=center>
 <p align=center>
<a class="qindex" href="group__bmqa.html" target="_blank">bmqa</a> | <a class="qindex" href="group__bmqpi.html" target="_blank">bmqpi</a> | <a class="qindex" href="group__bmqt.html" target="_blank">bmqt</a>
 </td>
 </tr>
 </table>

  </div>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul class="tablist">
      <li><a href="components.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="components.html"><span>Components</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath">
    <ul>
      <li><a class="el" href="namespacebmqa.html">bmqa</a>      </li>
      <li><a class="el" href="classbmqa_1_1MessagePropertiesIterator.html">bmqa::MessagePropertiesIterator</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<h1>bmqa::MessagePropertiesIterator Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="bmqa::MessagePropertiesIterator" -->
<p><code>#include &lt;<a class="el" href="bmqa__messageproperties_8h_source.html">bmqa_messageproperties.h</a>&gt;</code></p>

<p><a href="classbmqa_1_1MessagePropertiesIterator-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1MessagePropertiesIterator.html#aa2f52ac6864cb0e4ab2147d810092735">MessagePropertiesIterator</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1MessagePropertiesIterator.html#a3450076a3c631f053216dcfdb74c16a1">MessagePropertiesIterator</a> (const <a class="el" href="classbmqa_1_1MessageProperties.html">MessageProperties</a> *properties)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1MessagePropertiesIterator.html#a8335500180ad4e2f8896b2ed1d344bd8">MessagePropertiesIterator</a> (const <a class="el" href="classbmqa_1_1MessagePropertiesIterator.html">MessagePropertiesIterator</a> &amp;other)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1MessagePropertiesIterator.html#a1c4a15147b338e34b23f6553d7045f66">~MessagePropertiesIterator</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbmqa_1_1MessagePropertiesIterator.html">MessagePropertiesIterator</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1MessagePropertiesIterator.html#acd59e350b1818cb4ac9ef766427f65f0">operator=</a> (const <a class="el" href="classbmqa_1_1MessagePropertiesIterator.html">MessagePropertiesIterator</a> &amp;rhs)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1MessagePropertiesIterator.html#ab8749c4be4053c22c0644eee69ac88c2">hasNext</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const bsl::string &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1MessagePropertiesIterator.html#a80a08bb33ac06e4bee940a7ab1c29ca5">name</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structbmqt_1_1PropertyType.html#a80bd813e5d93e5ec67b08cd4eda36107">bmqt::PropertyType::Enum</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1MessagePropertiesIterator.html#a9214cc87bb07bd1348892c9519c6a0ed">type</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1MessagePropertiesIterator.html#a1dcc16f44dbfb08342766a7c65cc4542">getAsBool</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1MessagePropertiesIterator.html#aeebf4e08612318be39624acadb475ac4">getAsChar</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">short&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1MessagePropertiesIterator.html#a9be315505f0b86dd9159aa0252abe783">getAsShort</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bsl::int32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1MessagePropertiesIterator.html#ac7f3a7f98355f0027ea37ebe4aec4d23">getAsInt32</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bsls::Types::Int64&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1MessagePropertiesIterator.html#a4b6a381973cc5ccfe29672cb5a569baa">getAsInt64</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const bsl::string &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1MessagePropertiesIterator.html#a289b08a8f1a093cb2caa5c193050c280">getAsString</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const bsl::vector&lt; char &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1MessagePropertiesIterator.html#af4460da7192b4d18c75a4a6dc26b1b8b">getAsBinary</a> () const </td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Provide a mechanism to iterator over all the properties in an instance of <code><a class="el" href="classbmqa_1_1MessageProperties.html">bmqa::MessageProperties</a></code>. The order of the iteration is implementation defined. An iterator is <em>valid</em> if it is associated with a property , otherwise it is <em>invalid</em>. Behavior is undefined if the underlying instance of <code><a class="el" href="classbmqa_1_1MessageProperties.html">bmqa::MessageProperties</a></code> is modified during the lifetime of this iterator.</p>
<p>See <a class="el" href="group__bmqa__messageproperties.html">Component bmqa_messageproperties</a> </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aa2f52ac6864cb0e4ab2147d810092735"></a><!-- doxytag: member="bmqa::MessagePropertiesIterator::MessagePropertiesIterator" ref="aa2f52ac6864cb0e4ab2147d810092735" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bmqa::MessagePropertiesIterator::MessagePropertiesIterator </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Create an empty iterator instance. The only valid operations that can be invoked on an empty instance are copying, assignment and destruction. </p>

</div>
</div>
<a class="anchor" id="a3450076a3c631f053216dcfdb74c16a1"></a><!-- doxytag: member="bmqa::MessagePropertiesIterator::MessagePropertiesIterator" ref="a3450076a3c631f053216dcfdb74c16a1" args="(const MessageProperties *properties)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bmqa::MessagePropertiesIterator::MessagePropertiesIterator </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classbmqa_1_1MessageProperties.html">MessageProperties</a> *&nbsp;</td>
          <td class="paramname"> <em>properties</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [explicit]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Create an iterator for the specified <code>properties</code>. Behavior is undefined unless <code>properties</code> is not null. </p>

</div>
</div>
<a class="anchor" id="a8335500180ad4e2f8896b2ed1d344bd8"></a><!-- doxytag: member="bmqa::MessagePropertiesIterator::MessagePropertiesIterator" ref="a8335500180ad4e2f8896b2ed1d344bd8" args="(const MessagePropertiesIterator &amp;other)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bmqa::MessagePropertiesIterator::MessagePropertiesIterator </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classbmqa_1_1MessagePropertiesIterator.html">MessagePropertiesIterator</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>other</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Copy constructor from the specified <code>other</code>. </p>

</div>
</div>
<a class="anchor" id="a1c4a15147b338e34b23f6553d7045f66"></a><!-- doxytag: member="bmqa::MessagePropertiesIterator::~MessagePropertiesIterator" ref="a1c4a15147b338e34b23f6553d7045f66" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bmqa::MessagePropertiesIterator::~MessagePropertiesIterator </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Destroy this iterator. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="acd59e350b1818cb4ac9ef766427f65f0"></a><!-- doxytag: member="bmqa::MessagePropertiesIterator::operator=" ref="acd59e350b1818cb4ac9ef766427f65f0" args="(const MessagePropertiesIterator &amp;rhs)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classbmqa_1_1MessagePropertiesIterator.html">MessagePropertiesIterator</a>&amp; bmqa::MessagePropertiesIterator::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classbmqa_1_1MessagePropertiesIterator.html">MessagePropertiesIterator</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>rhs</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Assignment operator from the specified <code>rhs</code>. </p>

</div>
</div>
<a class="anchor" id="ab8749c4be4053c22c0644eee69ac88c2"></a><!-- doxytag: member="bmqa::MessagePropertiesIterator::hasNext" ref="ab8749c4be4053c22c0644eee69ac88c2" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool bmqa::MessagePropertiesIterator::hasNext </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Advance this iterator to refer to the next property of the associated <code><a class="el" href="classbmqa_1_1MessageProperties.html">MessageProperties</a></code> instance, if there is one and return true, return false otherwise. Behavior is undefined unless this method is being invoked for the first time on this object or previous call to <code>hasNext</code> returned true. Note that the order of the iteration is not specified. </p>

</div>
</div>
<a class="anchor" id="a80a08bb33ac06e4bee940a7ab1c29ca5"></a><!-- doxytag: member="bmqa::MessagePropertiesIterator::name" ref="a80a08bb33ac06e4bee940a7ab1c29ca5" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const bsl::string&amp; bmqa::MessagePropertiesIterator::name </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return a reference offering non-modifiable access to the name of the property being pointed by the iterator. Behavior is undefined unless last call to <code>hasNext</code> returned true. </p>

</div>
</div>
<a class="anchor" id="a9214cc87bb07bd1348892c9519c6a0ed"></a><!-- doxytag: member="bmqa::MessagePropertiesIterator::type" ref="a9214cc87bb07bd1348892c9519c6a0ed" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structbmqt_1_1PropertyType.html#a80bd813e5d93e5ec67b08cd4eda36107">bmqt::PropertyType::Enum</a> bmqa::MessagePropertiesIterator::type </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return the data type of property being pointed by the iterator. Behavior is undefined unless last call to <code>hasNext</code> returned true; </p>

</div>
</div>
<a class="anchor" id="a1dcc16f44dbfb08342766a7c65cc4542"></a><!-- doxytag: member="bmqa::MessagePropertiesIterator::getAsBool" ref="a1dcc16f44dbfb08342766a7c65cc4542" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool bmqa::MessagePropertiesIterator::getAsBool </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="aeebf4e08612318be39624acadb475ac4"></a><!-- doxytag: member="bmqa::MessagePropertiesIterator::getAsChar" ref="aeebf4e08612318be39624acadb475ac4" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char bmqa::MessagePropertiesIterator::getAsChar </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a9be315505f0b86dd9159aa0252abe783"></a><!-- doxytag: member="bmqa::MessagePropertiesIterator::getAsShort" ref="a9be315505f0b86dd9159aa0252abe783" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">short bmqa::MessagePropertiesIterator::getAsShort </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="ac7f3a7f98355f0027ea37ebe4aec4d23"></a><!-- doxytag: member="bmqa::MessagePropertiesIterator::getAsInt32" ref="ac7f3a7f98355f0027ea37ebe4aec4d23" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bsl::int32_t bmqa::MessagePropertiesIterator::getAsInt32 </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a4b6a381973cc5ccfe29672cb5a569baa"></a><!-- doxytag: member="bmqa::MessagePropertiesIterator::getAsInt64" ref="a4b6a381973cc5ccfe29672cb5a569baa" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bsls::Types::Int64 bmqa::MessagePropertiesIterator::getAsInt64 </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a289b08a8f1a093cb2caa5c193050c280"></a><!-- doxytag: member="bmqa::MessagePropertiesIterator::getAsString" ref="a289b08a8f1a093cb2caa5c193050c280" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const bsl::string&amp; bmqa::MessagePropertiesIterator::getAsString </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="af4460da7192b4d18c75a4a6dc26b1b8b"></a><!-- doxytag: member="bmqa::MessagePropertiesIterator::getAsBinary" ref="af4460da7192b4d18c75a4a6dc26b1b8b" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const bsl::vector&lt;char&gt;&amp; bmqa::MessagePropertiesIterator::getAsBinary </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return property value having the corresponding type being currently being pointed by this iterator instance. Behavior is undefined unless last call to <code>hasNext</code> returned true. Behavior is also undefined unless property's data type matches the requested type. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="bmqa__messageproperties_8h_source.html">bmqa_messageproperties.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Jun 15 2023 11:58:51 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
